Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add note about bcftools version for merging to annotaTR #245

Merged
merged 2 commits into from
Dec 12, 2024

Conversation

gymreklab
Copy link
Contributor

This PR makes some minor clarifications to the annotaTR readme.

  • Adds a note that older bcftools versions might switch allele order when doing bcftools merge, and that we tested on v1.20
  • Minor clarification to options for --match-refpanel-on.

Resolves #244

Checklist

  • [x ] I've checked to ensure there aren't already other open pull requests for the same update/change
  • [ x] I've prefixed the title of my PR according to the conventional commits specification. If your PR fixes a bug, please prefix the PR with fix: . Otherwise, if it introduces a new feature, please prefix it with feat: . If it introduces a breaking change, please add an exclamation before the colon, like feat!: . If the scope of the PR changes because of a revision to it, please update the PR title, since the title will be used in our CHANGELOG.
  • [ x] At the top of the PR, I've listed any open issues that this PR will resolve. For example, "resolves #0" if this PR resolves issue #0
  • [ x] I've explained my changes in a manner that will make it possible for both users and maintainers of TRTools to understand them
  • [x ] I've added tests for any new functionality. Or, if this PR fixes a bug, I've added test(s) that replicate it
  • [x ] All directories with large test files are listed in the "exclude" section of our pyproject.toml so that they do not appear in our PyPI distribution. All new files are also smaller than 0.5 MB.
  • [x ] I've updated the relevant REAMDEs with any new usage information and checked that the newly built documentation is formatted properly
  • [ x] All functions, modules, classes etc. still conform to numpy docstring standards
  • [ x] (if applicable) I've updated the pyproject.toml file with any changes I've made to TRTools's dependencies, and I've run poetry lock --no-update to ensure the lock file stays up to date and that our dependencies are locked to their minimum versions
  • [ x] In the body of this PR, I've included a short address to the reviewer highlighting one or two items that might deserve their focus

Melissa Gymrek and others added 2 commits December 11, 2024 09:24
fix issue with nested bullet points creating bold font on higher level bullet
@gymreklab gymreklab requested a review from nicholema December 11, 2024 17:35
@gymreklab gymreklab changed the title doc: add note about bcftools version for merging to annotaTR docs: add note about bcftools version for merging to annotaTR Dec 11, 2024
Copy link
Contributor

@nicholema nicholema left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The explanation looks good to me

@gymreklab gymreklab merged commit 6a2d4fb into master Dec 12, 2024
14 checks passed
@gymreklab gymreklab deleted the update-annotatr-docs branch December 12, 2024 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

annotaTR - bcftools merge related issue for large cohorts
2 participants